org.springframework.orm.jpa.vendor

Class HibernateJpaVendorAdapter

java.lang.Object

org.springframework.orm.jpa.vendor.AbstractJpaVendorAdapter

org.springframework.orm.jpa.vendor.HibernateJpaVendorAdapter

All Implemented Interfaces:

JpaVendorAdapter

public class HibernateJpaVendorAdapter
extends AbstractJpaVendorAdapter

JpaVendorAdapter implementation for Hibernate EntityManager. Developed and tested against Hibernate 3.6, 4.2/4.3 as well as 5.x. Hibernate 4.2+ is strongly recommended for use with Spring 4.0+.

Exposes Hibernate's persistence provider and EntityManager extension interface, and adapts AbstractJpaVendorAdapter's common configuration settings. Also supports the detection of annotated packages (through SmartPersistenceUnitInfo.getManagedPackages()), e.g. containing Hibernate org.hibernate.annotations.FilterDef annotations, along with Spring-driven entity scanning which requires no persistence.xml (LocalContainerEntityManagerFactoryBean.setPackagesToScan(java.lang.String...)).

Note that the package location of Hibernate's JPA support changed from 4.2 to 4.3: from org.hibernate.ejb.HibernateEntityManager(Factory) to org.hibernate.jpa.HibernateEntityManager(Factory). As of Spring 4.0, we're exposing the correct, non-deprecated variant depending on the Hibernate version encountered at runtime, in order to avoid deprecation log entries.

Since:

2.0

Author:

Juergen Hoeller, Rod Johnson

See Also:

HibernateJpaDialect, org.hibernate.ejb.HibernatePersistence, org.hibernate.ejb.HibernateEntityManager

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Class<? extends EntityManagerFactory>	entityManagerFactoryInterface
private java.lang.Class<? extends EntityManager>	entityManagerInterface
private HibernateJpaDialect	jpaDialect
private PersistenceProvider	persistenceProvider

Constructor Summary

Constructors

Constructor and Description
HibernateJpaVendorAdapter()

Method Summary

Modifier and Type	Method and Description
protected java.lang.Class<?>	determineDatabaseDialectClass(Database database) Determine the Hibernate database dialect class for the given target database.
java.lang.Class<? extends EntityManagerFactory>	getEntityManagerFactoryInterface() Return the vendor-specific EntityManagerFactory interface that the EntityManagerFactory proxy is supposed to implement.
java.lang.Class<? extends EntityManager>	getEntityManagerInterface() Return the vendor-specific EntityManager interface that this provider's EntityManagers will implement.
HibernateJpaDialect	getJpaDialect() Return the vendor-specific JpaDialect implementation for this provider, or null if there is none.
java.util.Map<java.lang.String,java.lang.Object>	getJpaPropertyMap() Return a Map of vendor-specific JPA properties, typically based on settings in this JpaVendorAdapter instance.
PersistenceProvider	getPersistenceProvider() Return the vendor-specific persistence provider.
java.lang.String	getPersistenceProviderRootPackage() Return the name of the persistence provider's root package (e.g.
void	setPrepareConnection(boolean prepareConnection) Set whether to prepare the underlying JDBC Connection of a transactional Hibernate Session, that is, whether to apply a transaction-specific isolation level and/or the transaction's read-only flag to the underlying JDBC Connection.

Methods inherited from class org.springframework.orm.jpa.vendor.AbstractJpaVendorAdapter

getDatabase, getDatabasePlatform, isGenerateDdl, isShowSql, postProcessEntityManagerFactory, setDatabase, setDatabasePlatform, setGenerateDdl, setShowSql

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

jpaDialect

private final HibernateJpaDialect jpaDialect

persistenceProvider

private final PersistenceProvider persistenceProvider

entityManagerFactoryInterface

private final java.lang.Class<? extends EntityManagerFactory> entityManagerFactoryInterface

entityManagerInterface

private final java.lang.Class<? extends EntityManager> entityManagerInterface

Constructor Detail

HibernateJpaVendorAdapter

public HibernateJpaVendorAdapter()

Method Detail

setPrepareConnection

public void setPrepareConnection(boolean prepareConnection)

Set whether to prepare the underlying JDBC Connection of a transactional Hibernate Session, that is, whether to apply a transaction-specific isolation level and/or the transaction's read-only flag to the underlying JDBC Connection.

See HibernateJpaDialect.setPrepareConnection(boolean) for details. This is just a convenience flag passed through to HibernateJpaDialect.

On Hibernate 5.2, this flag remains true by default like against previous Hibernate versions. The vendor adapter manually enforces Hibernate's new connection handling mode DELAYED_ACQUISITION_AND_HOLD in that case unless a user-specified connection handling mode property indicates otherwise; switch this flag to false to avoid that interference.

Since:

4.3.1

See Also:

getJpaPropertyMap(), HibernateJpaDialect.beginTransaction(EntityManager, org.springframework.transaction.TransactionDefinition)

getPersistenceProvider

public PersistenceProvider getPersistenceProvider()

Description copied from interface: JpaVendorAdapter

Return the vendor-specific persistence provider.

getPersistenceProviderRootPackage

public java.lang.String getPersistenceProviderRootPackage()

Description copied from interface: JpaVendorAdapter

Return the name of the persistence provider's root package (e.g. "oracle.toplink.essentials"). Will be used for excluding provider classes from temporary class overriding.

Specified by:

getPersistenceProviderRootPackage in interface JpaVendorAdapter

Overrides:

getPersistenceProviderRootPackage in class AbstractJpaVendorAdapter

getJpaPropertyMap

public java.util.Map<java.lang.String,java.lang.Object> getJpaPropertyMap()

Description copied from interface: JpaVendorAdapter

Return a Map of vendor-specific JPA properties, typically based on settings in this JpaVendorAdapter instance.

Note that there might be further JPA properties defined on the EntityManagerFactory bean, which might potentially override individual JPA property values specified here.

Specified by:

getJpaPropertyMap in interface JpaVendorAdapter

Overrides:

getJpaPropertyMap in class AbstractJpaVendorAdapter

Returns:

a Map of JPA properties, as accepted by the standard JPA bootstrap facilities, or null or an empty Map if there are no such properties to expose

See Also:

javax.persistence.Persistence#createEntityManagerFactory(String, java.util.Map), javax.persistence.spi.PersistenceProvider#createContainerEntityManagerFactory(javax.persistence.spi.PersistenceUnitInfo, java.util.Map)

determineDatabaseDialectClass

protected java.lang.Class<?> determineDatabaseDialectClass(Database database)

Determine the Hibernate database dialect class for the given target database.

Parameters:

database - the target database

Returns:

the Hibernate database dialect class, or null if none found

getJpaDialect

public HibernateJpaDialect getJpaDialect()

Description copied from interface: JpaVendorAdapter

Return the vendor-specific JpaDialect implementation for this provider, or null if there is none.

Specified by:

getJpaDialect in interface JpaVendorAdapter

Overrides:

getJpaDialect in class AbstractJpaVendorAdapter

getEntityManagerFactoryInterface

public java.lang.Class<? extends EntityManagerFactory> getEntityManagerFactoryInterface()

Description copied from interface: JpaVendorAdapter

Return the vendor-specific EntityManagerFactory interface that the EntityManagerFactory proxy is supposed to implement.

If the provider does not offer any EntityManagerFactory extensions, the adapter should simply return the standard javax.persistence.EntityManagerFactory class here.

Specified by:

getEntityManagerFactoryInterface in interface JpaVendorAdapter

Overrides:

getEntityManagerFactoryInterface in class AbstractJpaVendorAdapter

getEntityManagerInterface

public java.lang.Class<? extends EntityManager> getEntityManagerInterface()

Description copied from interface: JpaVendorAdapter

Return the vendor-specific EntityManager interface that this provider's EntityManagers will implement.

If the provider does not offer any EntityManager extensions, the adapter should simply return the standard javax.persistence.EntityManager class here.

Specified by:

getEntityManagerInterface in interface JpaVendorAdapter

Overrides:

getEntityManagerInterface in class AbstractJpaVendorAdapter